com.doclinx.jftr
Class DBDOCHIT

java.lang.Object
  |
  +--com.doclinx.jftr.DOCHIT
        |
        +--com.doclinx.jftr.DBDOCHIT

public final class DBDOCHIT
extends DOCHIT

This class is a structure containing result information from a search AND includes the catalog index where the result occured. A DBDOCHIT is available for each location matching a query. A DBDOCHIT contains the catalog DB index, the document ID of the match along with the total number of matches in the document.

See Also:
CatalogSearch

Field Summary
 int db
          Database index.
 
Fields inherited from class com.doclinx.jftr.DOCHIT
docId, hitCount
 
Constructor Summary
DBDOCHIT(int db, com.doclinx.jftr.DOCHIT dh)
          Constructor to initialize class object.
DBDOCHIT(int db, int d, int h)
          Constructor to initialize class object.
 
Method Summary
 int getDB()
          Return objects database index.
 
Methods inherited from class com.doclinx.jftr.DOCHIT
equals, getAsMem, getDocument, getHitCount, getRelevancy, sizeof
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

db

public int db
Database index. This corresponds to the catalog # index.

Constructor Detail

DBDOCHIT

public DBDOCHIT(int db,
                int d,
                int h)
Constructor to initialize class object.

Parameters:
db - Catalog/DB index.
d - Document ID.
h - Hit count.

DBDOCHIT

public DBDOCHIT(int db,
                com.doclinx.jftr.DOCHIT dh)
Constructor to initialize class object.

Parameters:
db - Catalog/DB index.
dh - Standard catalog specific document hit object.
Method Detail

getDB

public int getDB()
Return objects database index.

Returns:
Catalog index (0..n-1)